Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #50

Merged
merged 5 commits into from
Dec 2, 2024
Merged

Update README.md #50

merged 5 commits into from
Dec 2, 2024

Conversation

Abhinegi2
Copy link
Contributor

@Abhinegi2 Abhinegi2 commented Nov 13, 2024

Description of changes

  1. Updated the view of the readme doc.
  2. Updated outdated links and added notes where needed

@Abhinegi2 Abhinegi2 marked this pull request as ready for review November 27, 2024 06:14
@Abhinegi2 Abhinegi2 self-assigned this Nov 27, 2024
docs/developer/README.md Outdated Show resolved Hide resolved
docs/developer/README.md Outdated Show resolved Hide resolved
docs/developer/README.md Outdated Show resolved Hide resolved
docs/developer/README.md Outdated Show resolved Hide resolved
docs/developer/README.md Outdated Show resolved Hide resolved
Comment on lines 103 to 138

For a basic setup without Docker, follow these steps.

### Step 1: Set Up CouchDB
1. Install CouchDB on Mac:
```shell
   brew install couchdb
```
2. Configure CouchDB:
```shell
   nano /opt/homebrew/etc/local.ini
```
3. Restart CouchDB:
```shell
   brew services restart couchdb
```
4. Access CouchDB at [http://localhost:5984/_utils/#](http://localhost:5984/_utils/#).

### Step 2: Create Databases
1. Create the following databases in CouchDB:
- `app`
- `app-attachments`
- `notification-webhook`
- `Report-calculation`

3. In the `app` database, add these configuration documents:
- **Config:CONFIG_ENTITY**
- **Config:Permissions**

**Note**: Please reach out to the tech team to get the specific details for these configuration documents.

### Step 3: Set Up Replication Backend
- Follow the project setup instructions provided in the [Backend Setup Guideline](https://github.com/Aam-Digital/replication-backend/blob/master/README.md).

Once completed, you’ll have a minimal local environment without Docker.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this one actually work, @Abhinegi2 ? Or does this run into the issue of data not syncing to the local CouchDB because authentication is missing?

Copy link
Contributor Author

@Abhinegi2 Abhinegi2 Dec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sleidig It works, but I think anyone working in the app needs to sync with the database at least once, so this might not be very helpful without authentication. Can I remove this? However, for just fetching the data—like we do in public forms—it can still retrieve the data successfully.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if the normal create/update entities is not supported, then I think this option is more confusing than helpful. Let's remove it if that is the only case

Copy link
Contributor Author

@Abhinegi2 Abhinegi2 Dec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sleidig removed the mentioned section have a look now

@Abhinegi2 Abhinegi2 requested a review from sleidig December 2, 2024 13:15
@sleidig
Copy link
Member

sleidig commented Dec 2, 2024

@tomwwinter can you have a quick look over this and merge it, if it looks okay to you as well?

@tomwwinter tomwwinter merged commit 9b64357 into main Dec 2, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants